MarkLogic 12 Product Documentation
GET /v1/domains/{domain-id-or-default-domain-name}/status

Summary

This resource returns the status for the domain.

URL Parameters
format The format of the returned data. Can be either html, json, or xml (default). This value overrides the Accept header if both are present.
with-targets Can be either true or false.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. If the URI is malformed or the database does not exist, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires the flexrep-admin role, or the following privilege:

http://marklogic.com/xdmp/privileges/flexrep-admin

Usage Notes

The returned information is the output of flexrep:domain-status().

The information is the same as is returned from the flexrep:target-status() API.

Example


  => 
  { "domain-id":"11823208805791791213",
  "document-count":0,
  "unpropertied-count":0,
  "deleted-count":0,
  "pending-count":0,
  "error-count":0,
  "cpf-active-count":0,
  "cpf-error-count":0,
  "cpf-final-count":0,
  "cpf-initial-count":0,
  "cpf-updated-count":0,
  "partial-count":0,
  "deleted-targets-count":0,
  "target-statuses":
    [ {"target-id":"1563671060741473909",
       "target-name":"push",
       "pending-retry-count":0,
       "missing-count":0,
       "error-count":0,
       "waiting-binary-count":0
      },
      { ... }
	  ]
}
Powered by MarkLogic Server | Terms of Use | Privacy Policy